Meshtastic App/com.geeksville.mesh.ui.common.components

Package-level declarations

Types

BatteryInfoPreviewParameterProvider

class BatteryInfoPreviewParameterProvider : PreviewParameterProvider<Pair<Int?, Float?>>

BatteryLevelProvider

class BatteryLevelProvider : PreviewParameterProvider<Int>

BooleanProvider

class BooleanProvider : PreviewParameterProvider<Boolean>

Simple PreviewParameterProvider that provides true and false values.

DragDropState

class DragDropState

Iaq

enum Iaq : Enum<Iaq>

IaqDisplayMode

enum IaqDisplayMode : Enum<IaqDisplayMode>

SecurityState

@Immutable

enum SecurityState : Enum<SecurityState>

Represents the various visual states of the security icon as an enum. Each enum constant encapsulates the icon, color, descriptive text, and optional badge details.

Properties

DragDropContentType

const val DragDropContentType: String

isLowEntropyKey

val Channel.isLowEntropyKey: Boolean

Extension property to check if the channel uses a low entropy PSK (not securely encrypted).

isMqttEnabled

val Channel.isMqttEnabled: Boolean

Extension property to check if MQTT is enabled for the channel.

isPreciseLocation

val Channel.isPreciseLocation: Boolean

Extension property to check if the channel has precise location enabled.

MAX_VALID_RSSI

const val MAX_VALID_RSSI: Int = 0

MAX_VALID_SNR

const val MAX_VALID_SNR: Float = 100.0f

previewNode

val previewNode: Node

Functions

AdaptiveTwoPane

@Composable

fun AdaptiveTwoPane(first: @Composable ColumnScope.() -> Unit, second: @Composable ColumnScope.() -> Unit)

BatteryInfo

@Composable

fun BatteryInfo(modifier: Modifier = Modifier, batteryLevel: Int?, voltage: Float?)

BatteryInfoPreview

@Composable

fun BatteryInfoPreview(batteryInfo: Pair<Int?, Float?>)

BatteryInfoPreviewSimple

@Composable

@Preview

fun BatteryInfoPreviewSimple()

BitwisePreference

@Composable

fun BitwisePreference(title: String, value: Int, enabled: Boolean, items: List<Pair<Int, String>>, onItemSelected: (Int) -> Unit, modifier: Modifier = Modifier)

BottomSheetDialog

@Composable

fun BottomSheetDialog(onDismiss: () -> Unit, modifier: Modifier = Modifier, content: @Composable ColumnScope.() -> Unit)

ClickableTextField

@Composable

fun ClickableTextField(@StringRes label: Int, enabled: Boolean, trailingIcon: ImageVector, value: String, onClick: () -> Unit, modifier: Modifier = Modifier, isError: Boolean = false)

CopyIconButton

@Composable

fun CopyIconButton(valueToCopy: String, modifier: Modifier = Modifier, label: String = stringResource(id = R.string.copy))

dragContainer

fun Modifier.dragContainer(dragDropState: DragDropState, haptics: HapticFeedback): Modifier

dragDropItemsIndexed

inline fun <T> LazyListScope.dragDropItemsIndexed(items: List<T>, dragDropState: DragDropState, noinline key: (index: Int, item: T) -> Any? = null, crossinline itemContent: @Composable LazyItemScope.(index: Int, item: T, isDragging: Boolean) -> Unit)

Extension function for LazyListScope with drag-and-drop functionality for indexed items.

DraggableItem

@Composable

fun LazyItemScope.DraggableItem(dragDropState: DragDropState, index: Int, modifier: Modifier = Modifier, content: @Composable ColumnScope.(isDragging: Boolean) -> Unit)

DropDownPreference

@Composable

fun <T : Enum<T>> DropDownPreference(title: String, enabled: Boolean, selectedItem: T, onItemSelected: (T) -> Unit, modifier: Modifier = Modifier, summary: String? = null)

@Composable

fun <T> DropDownPreference(title: String, enabled: Boolean, items: List<Pair<T, String>>, selectedItem: T, onItemSelected: (T) -> Unit, modifier: Modifier = Modifier, summary: String? = null)

EditBase64Preference

@Composable

fun EditBase64Preference(modifier: Modifier = Modifier, title: String, value: ByteString, enabled: Boolean, readOnly: Boolean = false, keyboardActions: KeyboardActions, onValueChange: (ByteString) -> Unit, onGenerateKey: () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null)

EditIPv4Preference

@Composable

fun EditIPv4Preference(title: String, value: Int, enabled: Boolean, keyboardActions: KeyboardActions, onValueChanged: (Int) -> Unit, modifier: Modifier = Modifier)

EditListPreference

@Composable

inline fun <T> EditListPreference(title: String, list: List<T>, maxCount: Int, enabled: Boolean, keyboardActions: KeyboardActions, crossinline onValuesChanged: (List<T>) -> Unit, modifier: Modifier = Modifier)

EditPasswordPreference

@Composable

fun EditPasswordPreference(title: String, value: String, maxSize: Int, enabled: Boolean, keyboardActions: KeyboardActions, onValueChanged: (String) -> Unit, modifier: Modifier = Modifier)

EditTextPreference

@Composable

fun EditTextPreference(title: String, value: Double, enabled: Boolean, keyboardActions: KeyboardActions, onValueChanged: (Double) -> Unit, modifier: Modifier = Modifier)

@Composable

fun EditTextPreference(title: String, value: Float, enabled: Boolean, keyboardActions: KeyboardActions, onValueChanged: (Float) -> Unit, modifier: Modifier = Modifier, onFocusChanged: (FocusState) -> Unit = {})

@Composable

fun EditTextPreference(title: String, value: Int, enabled: Boolean, isError: Boolean = false, keyboardActions: KeyboardActions, onValueChanged: (Int) -> Unit, modifier: Modifier = Modifier, onFocusChanged: (FocusState) -> Unit = {}, trailingIcon: @Composable () -> Unit? = null)

@Composable

fun EditTextPreference(title: String, value: String, enabled: Boolean, isError: Boolean, keyboardOptions: KeyboardOptions, keyboardActions: KeyboardActions, onValueChanged: (String) -> Unit, modifier: Modifier = Modifier, maxSize: Int = 0, onFocusChanged: (FocusState) -> Unit = {}, trailingIcon: @Composable () -> Unit? = null, visualTransformation: VisualTransformation = VisualTransformation.None)

EmojiPicker

@Composable

fun EmojiPicker(viewModel: EmojiPickerViewModel = hiltViewModel(), onDismiss: () -> Unit = {}, onConfirm: (String) -> Unit)

EmojiPickerDialog

@Composable

fun EmojiPickerDialog(onDismiss: () -> Unit = {}, onConfirm: (String) -> Unit)

getIaq

fun getIaq(iaq: Int): Iaq?

IAQScale

@Composable

fun IAQScale(modifier: Modifier = Modifier)

IAQScalePreview

@Preview(showBackground = true)

@Composable

fun IAQScalePreview()

IndoorAirQuality

@Composable

fun IndoorAirQuality(iaq: Int?, displayMode: IaqDisplayMode = IaqDisplayMode.Pill)

LazyColumnDragAndDropDemo

@Preview

@Composable

fun LazyColumnDragAndDropDemo()

LoraSignalIndicator

@Composable

fun LoraSignalIndicator(snr: Float, rssi: Int)

Displays a human readable description and icon representing the signal quality.

MainAppBar

@Composable

fun MainAppBar(modifier: Modifier = Modifier, viewModel: UIViewModel = hiltViewModel(), navController: NavHostController, onAction: (NodeMenuAction) -> Unit)

MaterialBatteryInfo

@Composable

fun MaterialBatteryInfo(modifier: Modifier = Modifier, level: Int)

MaterialBatteryInfoPreview

@Composable

fun MaterialBatteryInfoPreview(batteryLevel: Int)

MDText

@Composable

fun MDText(text: String, modifier: Modifier = Modifier, style: TextStyle = MaterialTheme.typography.bodyMedium, color: Color = Color.Unspecified)

MultipleChoiceAlertDialog

@Composable

fun MultipleChoiceAlertDialog(title: String, message: String?, choices: Map<String, () -> Unit>, onDismissRequest: () -> Unit)

NodeSignalQuality

@Composable

fun NodeSignalQuality(snr: Float, rssi: Int, modifier: Modifier = Modifier)

Displays the snr and rssi color coded based on the signal quality, along with a human readable description and related icon.

OptionLabel

@Composable

fun OptionLabel(text: String)

Visual representation of the option the user may select.

PositionPrecisionPreference

@Composable

fun PositionPrecisionPreference(value: Int, enabled: Boolean, onValueChanged: (Int) -> Unit, modifier: Modifier = Modifier)

precisionBitsToMeters

fun precisionBitsToMeters(bits: Int): Double

PreferenceCategory

@Composable

fun PreferenceCategory(text: String, modifier: Modifier = Modifier, content: @Composable ColumnScope.() -> Unit? = null)

PreferenceFooter

@Composable

fun PreferenceFooter(enabled: Boolean, onCancelClicked: () -> Unit, onSaveClicked: () -> Unit, modifier: Modifier = Modifier)

@Composable

fun PreferenceFooter(enabled: Boolean, @StringRes negativeText: Int, onNegativeClicked: () -> Unit, @StringRes positiveText: Int, onPositiveClicked: () -> Unit, modifier: Modifier = Modifier)

RegularPreference

@Composable

fun RegularPreference(title: String, subtitle: AnnotatedString, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, summary: String? = null, trailingIcon: ImageVector? = null, dropdownMenu: @Composable () -> Unit = {})

@Composable

fun RegularPreference(title: String, subtitle: String, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, summary: String? = null, trailingIcon: ImageVector? = null, dropdownMenu: @Composable () -> Unit = {})

rememberDragDropState

@Composable

fun rememberDragDropState(lazyListState: LazyListState, headerCount: Int = 0, onMove: (Int, Int) -> Unit): DragDropState

rememberTimeTickWithLifecycle

@Composable

fun rememberTimeTickWithLifecycle(): Long

Rssi

@Composable

fun Rssi(rssi: Int, fontSize: TextUnit = MaterialTheme.typography.labelLarge.fontSize)

ScannedQrCodeDialog

@Composable

fun ScannedQrCodeDialog(viewModel: UIViewModel, incoming: <Error class: unknown class>)

@Composable

fun ScannedQrCodeDialog(channels: <Error class: unknown class>, incoming: <Error class: unknown class>, onDismiss: () -> Unit, onConfirm: (<Error class: unknown class>) -> Unit)

Enables the user to select which channels to accept after scanning a QR code.

SecurityIcon

@Composable

fun SecurityIcon(channel: Channel, baseContentDescription: String = stringResource(id = R.string.security_icon_description), externalOnClick: () -> Unit? = null)

Overload for SecurityIcon that takes a Channel object to determine its security state.

@Composable

fun SecurityIcon(securityState: SecurityState, baseContentDescription: String = stringResource(id = R.string.security_icon_description), externalOnClick: () -> Unit? = null)

Displays an icon representing the security status of a channel. Clicking the icon shows a detailed help dialog.

@Composable

fun SecurityIcon(channelSet: <Error class: unknown class>, channelIndex: Int, baseContentDescription: String = stringResource(id = R.string.security_icon_description), externalOnClick: () -> Unit? = null)

Overload for SecurityIcon that takes an AppOnlyProtos.ChannelSet and a channel index. If the channel at the given index is not found, nothing is rendered.

@Composable

fun SecurityIcon(channelSet: <Error class: unknown class>, channelName: String, baseContentDescription: String = stringResource(id = R.string.security_icon_description), externalOnClick: () -> Unit? = null)

Overload for SecurityIcon that takes an AppOnlyProtos.ChannelSet and a channel name. If a channel with the given name is not found, nothing is rendered. This overload optimizes lookup by name by memoizing a map of channel names to settings.

@Composable

fun SecurityIcon(channelSettings: <Error class: unknown class>, loraConfig: <Error class: unknown class>, baseContentDescription: String = stringResource(id = R.string.security_icon_description), externalOnClick: () -> Unit? = null)

Overload for SecurityIcon that enables recomposition when making changes to the ChannelSettings.

@Composable

fun SecurityIcon(isLowEntropyKey: Boolean, isPreciseLocation: Boolean = false, isMqttEnabled: Boolean = false, baseContentDescription: String = stringResource(id = R.string.security_icon_description), externalOnClick: () -> Unit? = null)

Overload for SecurityIcon that derives the SecurityState from boolean flags.

SignalInfo

@Composable

fun SignalInfo(modifier: Modifier = Modifier, node: Node, isThisNode: Boolean)

SignalInfoPreview

@Composable

fun SignalInfoPreview(node: Node)

SignalInfoSelfPreview

@Composable

fun SignalInfoSelfPreview(node: Node)

SignalInfoSimplePreview

@Composable

@Preview(showBackground = true)

fun SignalInfoSimplePreview()

SignedIntegerEditTextPreference

@Composable

fun SignedIntegerEditTextPreference(title: String, value: Int, enabled: Boolean, keyboardActions: KeyboardActions, onValueChanged: (Int) -> Unit, modifier: Modifier = Modifier, onFocusChanged: (FocusState) -> Unit = {}, trailingIcon: @Composable () -> Unit? = null)

SimpleAlertDialog

@Composable

fun SimpleAlertDialog(@StringRes title: Int, @StringRes text: Int, onConfirm: () -> Unit? = null, onDismiss: () -> Unit = {})

@Composable

fun SimpleAlertDialog(@StringRes title: Int, text: String, onConfirm: () -> Unit? = null, onDismiss: () -> Unit = {})

@Composable

fun SimpleAlertDialog(title: String, message: String?, html: String? = null, onDismissRequest: () -> Unit, onConfirmRequest: () -> Unit = onDismissRequest)

@Composable

fun SimpleAlertDialog(@StringRes title: Int, text: @Composable () -> Unit? = null, confirmText: String? = null, onConfirm: () -> Unit? = null, dismissText: String? = null, onDismiss: () -> Unit = {})

SlidingSelector

@Composable

fun <T : Any> SlidingSelector(options: List<T>, selectedOption: T, onOptionSelected: (T) -> Unit, modifier: Modifier = Modifier, content: @Composable (T) -> Unit)

Provides the user with a set of options they can choose from.

SlidingSelectorPreview

@Preview

@Composable

fun SlidingSelectorPreview()

Snr

@Composable

fun Snr(snr: Float, fontSize: TextUnit = MaterialTheme.typography.labelLarge.fontSize)

SnrAndRssi

@Composable

fun SnrAndRssi(snr: Float, rssi: Int)

Displays the snr and rssi with color depending on the values respectively.

SwitchPreference

@Composable

fun SwitchPreference(modifier: Modifier = Modifier, title: String, summary: String = "", checked: Boolean, enabled: Boolean, onCheckedChange: (Boolean) -> Unit, padding: PaddingValues? = null, containerColor: Color? = null, loading: Boolean = false)

TextDividerPreference

@Composable

fun TextDividerPreference(title: AnnotatedString, modifier: Modifier = Modifier, enabled: Boolean = true, trailingIcon: ImageVector? = null)

@Composable

fun TextDividerPreference(title: String, modifier: Modifier = Modifier, enabled: Boolean = true, trailingIcon: ImageVector? = null)

TitledCard

@Composable

fun TitledCard(title: String, modifier: Modifier = Modifier, content: @Composable ColumnScope.() -> Unit)